Skip to content

Conversation

@georgeh0
Copy link
Member

@georgeh0 georgeh0 commented Oct 2, 2025

No description provided.

@georgeh0 georgeh0 merged commit 171c06e into main Oct 2, 2025
4 checks passed
@georgeh0 georgeh0 deleted the g/cli-docs branch October 2, 2025 06:20
@Davda-James
Copy link
Contributor

@georgeh0 in this at top subcommands reference should have # heading start and increment additively over then, as current has changed to ## markdownlinter will give warning not satisfying "MD041/first-line-heading/first-line-h1: First line in a file should be a top-level heading", if we are okay with warnings then its okay but if not we have to change it (according to what we did in PR

@georgeh0
Copy link
Member Author

georgeh0 commented Oct 2, 2025

@georgeh0 in this at top subcommands reference should have # heading start and increment additively over then, as current has changed to ## markdownlinter will give warning not satisfying "MD041/first-line-heading/first-line-h1: First line in a file should be a top-level heading", if we are okay with warnings then its okay but if not we have to change it (according to what we did in PR

@Davda-James Thanks for pointing it out! I demote the levels of headings so that it'll be rendered well after being imoprted by cli.mdx. Otherwise it'll look weird.

I'm wondering which specific linter are you using? I'm not seeing this lint problem. We can also consider disable lints for generated files if it's bothering.

@Davda-James
Copy link
Contributor

@Davda-James
Copy link
Contributor

Also if we not care about linting it just gave us warnings, we can disable it.

@georgeh0
Copy link
Member Author

georgeh0 commented Oct 2, 2025

Thanks for the suggestion! Having #1107

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants